<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.math3.util;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import org.apache.commons.math3.exception.MaxCountExceededException;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.commons.math3.exception.NullArgumentException;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /**<a name="line.22"></a>
<FONT color="green">023</FONT>     * Utility that increments a counter until a maximum is reached, at<a name="line.23"></a>
<FONT color="green">024</FONT>     * which point, the instance will by default throw a<a name="line.24"></a>
<FONT color="green">025</FONT>     * {@link MaxCountExceededException}.<a name="line.25"></a>
<FONT color="green">026</FONT>     * However, the user is able to override this behaviour by defining a<a name="line.26"></a>
<FONT color="green">027</FONT>     * custom {@link MaxCountExceededCallback callback}, in order to e.g.<a name="line.27"></a>
<FONT color="green">028</FONT>     * select which exception must be thrown.<a name="line.28"></a>
<FONT color="green">029</FONT>     *<a name="line.29"></a>
<FONT color="green">030</FONT>     * @since 3.0<a name="line.30"></a>
<FONT color="green">031</FONT>     * @version $Id: Incrementor.java 1364389 2012-07-22 18:19:26Z tn $<a name="line.31"></a>
<FONT color="green">032</FONT>     */<a name="line.32"></a>
<FONT color="green">033</FONT>    public class Incrementor {<a name="line.33"></a>
<FONT color="green">034</FONT>        /**<a name="line.34"></a>
<FONT color="green">035</FONT>         * Upper limit for the counter.<a name="line.35"></a>
<FONT color="green">036</FONT>         */<a name="line.36"></a>
<FONT color="green">037</FONT>        private int maximalCount;<a name="line.37"></a>
<FONT color="green">038</FONT>        /**<a name="line.38"></a>
<FONT color="green">039</FONT>         * Current count.<a name="line.39"></a>
<FONT color="green">040</FONT>         */<a name="line.40"></a>
<FONT color="green">041</FONT>        private int count = 0;<a name="line.41"></a>
<FONT color="green">042</FONT>        /**<a name="line.42"></a>
<FONT color="green">043</FONT>         * Function called at counter exhaustion.<a name="line.43"></a>
<FONT color="green">044</FONT>         */<a name="line.44"></a>
<FONT color="green">045</FONT>        private final MaxCountExceededCallback maxCountCallback;<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>        /**<a name="line.47"></a>
<FONT color="green">048</FONT>         * Default constructor.<a name="line.48"></a>
<FONT color="green">049</FONT>         * For the new instance to be useful, the maximal count must be set<a name="line.49"></a>
<FONT color="green">050</FONT>         * by calling {@link #setMaximalCount(int) setMaximalCount}.<a name="line.50"></a>
<FONT color="green">051</FONT>         */<a name="line.51"></a>
<FONT color="green">052</FONT>        public Incrementor() {<a name="line.52"></a>
<FONT color="green">053</FONT>            this(0);<a name="line.53"></a>
<FONT color="green">054</FONT>        }<a name="line.54"></a>
<FONT color="green">055</FONT>    <a name="line.55"></a>
<FONT color="green">056</FONT>        /**<a name="line.56"></a>
<FONT color="green">057</FONT>         * Defines a maximal count.<a name="line.57"></a>
<FONT color="green">058</FONT>         *<a name="line.58"></a>
<FONT color="green">059</FONT>         * @param max Maximal count.<a name="line.59"></a>
<FONT color="green">060</FONT>         */<a name="line.60"></a>
<FONT color="green">061</FONT>        public Incrementor(int max) {<a name="line.61"></a>
<FONT color="green">062</FONT>            this(max,<a name="line.62"></a>
<FONT color="green">063</FONT>                 new MaxCountExceededCallback() {<a name="line.63"></a>
<FONT color="green">064</FONT>                     /** {@inheritDoc} */<a name="line.64"></a>
<FONT color="green">065</FONT>                     public void trigger(int max) {<a name="line.65"></a>
<FONT color="green">066</FONT>                         throw new MaxCountExceededException(max);<a name="line.66"></a>
<FONT color="green">067</FONT>                     }<a name="line.67"></a>
<FONT color="green">068</FONT>                 });<a name="line.68"></a>
<FONT color="green">069</FONT>        }<a name="line.69"></a>
<FONT color="green">070</FONT>    <a name="line.70"></a>
<FONT color="green">071</FONT>        /**<a name="line.71"></a>
<FONT color="green">072</FONT>         * Defines a maximal count and a callback method to be triggered at<a name="line.72"></a>
<FONT color="green">073</FONT>         * counter exhaustion.<a name="line.73"></a>
<FONT color="green">074</FONT>         *<a name="line.74"></a>
<FONT color="green">075</FONT>         * @param max Maximal count.<a name="line.75"></a>
<FONT color="green">076</FONT>         * @param cb Function to be called when the maximal count has been reached.<a name="line.76"></a>
<FONT color="green">077</FONT>         * @throws NullArgumentException if {@code cb} is {@code null}<a name="line.77"></a>
<FONT color="green">078</FONT>         */<a name="line.78"></a>
<FONT color="green">079</FONT>        public Incrementor(int max,<a name="line.79"></a>
<FONT color="green">080</FONT>                           MaxCountExceededCallback cb) {<a name="line.80"></a>
<FONT color="green">081</FONT>            if (cb == null){<a name="line.81"></a>
<FONT color="green">082</FONT>                throw new NullArgumentException();<a name="line.82"></a>
<FONT color="green">083</FONT>            }<a name="line.83"></a>
<FONT color="green">084</FONT>            maximalCount = max;<a name="line.84"></a>
<FONT color="green">085</FONT>            maxCountCallback = cb;<a name="line.85"></a>
<FONT color="green">086</FONT>        }<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>
<FONT color="green">088</FONT>        /**<a name="line.88"></a>
<FONT color="green">089</FONT>         * Sets the upper limit for the counter.<a name="line.89"></a>
<FONT color="green">090</FONT>         * This does not automatically reset the current count to zero (see<a name="line.90"></a>
<FONT color="green">091</FONT>         * {@link #resetCount()}).<a name="line.91"></a>
<FONT color="green">092</FONT>         *<a name="line.92"></a>
<FONT color="green">093</FONT>         * @param max Upper limit of the counter.<a name="line.93"></a>
<FONT color="green">094</FONT>         */<a name="line.94"></a>
<FONT color="green">095</FONT>        public void setMaximalCount(int max) {<a name="line.95"></a>
<FONT color="green">096</FONT>            maximalCount = max;<a name="line.96"></a>
<FONT color="green">097</FONT>        }<a name="line.97"></a>
<FONT color="green">098</FONT>    <a name="line.98"></a>
<FONT color="green">099</FONT>        /**<a name="line.99"></a>
<FONT color="green">100</FONT>         * Gets the upper limit of the counter.<a name="line.100"></a>
<FONT color="green">101</FONT>         *<a name="line.101"></a>
<FONT color="green">102</FONT>         * @return the counter upper limit.<a name="line.102"></a>
<FONT color="green">103</FONT>         */<a name="line.103"></a>
<FONT color="green">104</FONT>        public int getMaximalCount() {<a name="line.104"></a>
<FONT color="green">105</FONT>            return maximalCount;<a name="line.105"></a>
<FONT color="green">106</FONT>        }<a name="line.106"></a>
<FONT color="green">107</FONT>    <a name="line.107"></a>
<FONT color="green">108</FONT>        /**<a name="line.108"></a>
<FONT color="green">109</FONT>         * Gets the current count.<a name="line.109"></a>
<FONT color="green">110</FONT>         *<a name="line.110"></a>
<FONT color="green">111</FONT>         * @return the current count.<a name="line.111"></a>
<FONT color="green">112</FONT>         */<a name="line.112"></a>
<FONT color="green">113</FONT>        public int getCount() {<a name="line.113"></a>
<FONT color="green">114</FONT>            return count;<a name="line.114"></a>
<FONT color="green">115</FONT>        }<a name="line.115"></a>
<FONT color="green">116</FONT>    <a name="line.116"></a>
<FONT color="green">117</FONT>        /**<a name="line.117"></a>
<FONT color="green">118</FONT>         * Checks whether a single increment is allowed.<a name="line.118"></a>
<FONT color="green">119</FONT>         *<a name="line.119"></a>
<FONT color="green">120</FONT>         * @return {@code false} if the next call to {@link #incrementCount(int)<a name="line.120"></a>
<FONT color="green">121</FONT>         * incrementCount} will trigger a {@code MaxCountExceededException},<a name="line.121"></a>
<FONT color="green">122</FONT>         * {@code true} otherwise.<a name="line.122"></a>
<FONT color="green">123</FONT>         */<a name="line.123"></a>
<FONT color="green">124</FONT>        public boolean canIncrement() {<a name="line.124"></a>
<FONT color="green">125</FONT>            return count &lt; maximalCount;<a name="line.125"></a>
<FONT color="green">126</FONT>        }<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>        /**<a name="line.128"></a>
<FONT color="green">129</FONT>         * Performs multiple increments.<a name="line.129"></a>
<FONT color="green">130</FONT>         * See the other {@link #incrementCount() incrementCount} method).<a name="line.130"></a>
<FONT color="green">131</FONT>         *<a name="line.131"></a>
<FONT color="green">132</FONT>         * @param value Number of increments.<a name="line.132"></a>
<FONT color="green">133</FONT>         * @throws MaxCountExceededException at counter exhaustion.<a name="line.133"></a>
<FONT color="green">134</FONT>         */<a name="line.134"></a>
<FONT color="green">135</FONT>        public void incrementCount(int value) {<a name="line.135"></a>
<FONT color="green">136</FONT>            for (int i = 0; i &lt; value; i++) {<a name="line.136"></a>
<FONT color="green">137</FONT>                incrementCount();<a name="line.137"></a>
<FONT color="green">138</FONT>            }<a name="line.138"></a>
<FONT color="green">139</FONT>        }<a name="line.139"></a>
<FONT color="green">140</FONT>    <a name="line.140"></a>
<FONT color="green">141</FONT>        /**<a name="line.141"></a>
<FONT color="green">142</FONT>         * Adds one to the current iteration count.<a name="line.142"></a>
<FONT color="green">143</FONT>         * At counter exhaustion, this method will call the<a name="line.143"></a>
<FONT color="green">144</FONT>         * {@link MaxCountExceededCallback#trigger(int) trigger} method of the<a name="line.144"></a>
<FONT color="green">145</FONT>         * callback object passed to the<a name="line.145"></a>
<FONT color="green">146</FONT>         * {@link #Incrementor(int,MaxCountExceededCallback) constructor}.<a name="line.146"></a>
<FONT color="green">147</FONT>         * If not explictly set, a default callback is used that will throw<a name="line.147"></a>
<FONT color="green">148</FONT>         * a {@code MaxCountExceededException}.<a name="line.148"></a>
<FONT color="green">149</FONT>         *<a name="line.149"></a>
<FONT color="green">150</FONT>         * @throws MaxCountExceededException at counter exhaustion, unless a<a name="line.150"></a>
<FONT color="green">151</FONT>         * custom {@link MaxCountExceededCallback callback} has been set at<a name="line.151"></a>
<FONT color="green">152</FONT>         * construction.<a name="line.152"></a>
<FONT color="green">153</FONT>         */<a name="line.153"></a>
<FONT color="green">154</FONT>        public void incrementCount() {<a name="line.154"></a>
<FONT color="green">155</FONT>            if (++count &gt; maximalCount) {<a name="line.155"></a>
<FONT color="green">156</FONT>                maxCountCallback.trigger(maximalCount);<a name="line.156"></a>
<FONT color="green">157</FONT>            }<a name="line.157"></a>
<FONT color="green">158</FONT>        }<a name="line.158"></a>
<FONT color="green">159</FONT>    <a name="line.159"></a>
<FONT color="green">160</FONT>        /**<a name="line.160"></a>
<FONT color="green">161</FONT>         * Resets the counter to 0.<a name="line.161"></a>
<FONT color="green">162</FONT>         */<a name="line.162"></a>
<FONT color="green">163</FONT>        public void resetCount() {<a name="line.163"></a>
<FONT color="green">164</FONT>            count = 0;<a name="line.164"></a>
<FONT color="green">165</FONT>        }<a name="line.165"></a>
<FONT color="green">166</FONT>    <a name="line.166"></a>
<FONT color="green">167</FONT>        /**<a name="line.167"></a>
<FONT color="green">168</FONT>         * Defines a method to be called at counter exhaustion.<a name="line.168"></a>
<FONT color="green">169</FONT>         * The {@link #trigger(int) trigger} method should usually throw an exception.<a name="line.169"></a>
<FONT color="green">170</FONT>         */<a name="line.170"></a>
<FONT color="green">171</FONT>        public interface MaxCountExceededCallback {<a name="line.171"></a>
<FONT color="green">172</FONT>            /**<a name="line.172"></a>
<FONT color="green">173</FONT>             * Function called when the maximal count has been reached.<a name="line.173"></a>
<FONT color="green">174</FONT>             *<a name="line.174"></a>
<FONT color="green">175</FONT>             * @param maximalCount Maximal count.<a name="line.175"></a>
<FONT color="green">176</FONT>             */<a name="line.176"></a>
<FONT color="green">177</FONT>            void trigger(int maximalCount);<a name="line.177"></a>
<FONT color="green">178</FONT>        }<a name="line.178"></a>
<FONT color="green">179</FONT>    }<a name="line.179"></a>




























































</PRE>
</BODY>
</HTML>
